ShippingOptions API
Environments and Testing
Overview
You, as an integrating partner, are expected to maintain your own development, test and production environments from which to call the corresponding NZ Post Group environment and to follow the software development lifecycle.
Environment Detail
| Name | Use | Addresses |
|---|---|---|
| NZ Post Group User Acceptance Test (UAT) Environment | This environment is available for integration to test your solutions to ensure that calls to the API’s are technically correct and that the responses received are handled as they expect. This environment is available for system, integration and user acceptance testing. | https://api.uat.nzpost.co.nz/shippingoptions/2.0/ |
| Production Environment | This environment is for live use and is only available upon completion of the go-live checklist. | https://api.nzpost.co.nz/shippingoptions/2.0/ |
Testing Your Application
NZ Post Group is committed to making integration to its products easy and robust and are available to support your development and testing.
As with any development, NZ Post Group encourages you to test your application with both positive and negative scenarios. The following list of test cases has been provided for your convenience but it is not intended to be comprehensive. Some test cases may not apply to your use of the API. Please extend with test cases specific to your business.
| Suggested Test Cases | Expected Result |
|---|---|
| Retrieve shipping options for same city destination by dpid, parcel under 25 kg | Expected options are displayed |
| Retrieve shipping options for same city destination by site code, parcel over 25 kg | Expected options are displayed |
| Retrieve shipping options for different city destination by address_id, parcel is a tube | Expected options are displayed |
| Retrieve shipping options for different city destination by suburb and postcode, parcel is an envelope | Expected options are displayed |
| Retrieve shipping options for different city destination by town and postcode, parcel is an envelope | Expected options are displayed |
| Retrieve shipping options for rural destination, parcel under 3 kg | Expected options are displayed |
| Retrieve shipping options for rural destination, parcel over 3 kg | Expected options are displayed |
| Retrieve shipping options for international destination, parcel under 25 kg | Expected options are displayed |
| Retrieve shipping options for international destination, parcel over 25 kg | Expected options are displayed |